LotusScript Doc

Class: LSAPhoneNumberS

Maintaines a list of LSAPhoneItems

Version:
1.2.5, 23.NOV.2000
History:
23.NOV.2000RGRBug in Get PhoneNumberDefaults
11.AUG.2000RGRBug in Set PhoneFormat and Set CountriesWithoutAreaCode
26.JUL.2000RGRRefreshing list (formatted values) if handle to parent changes
25.JUL.2000RGRPhoneFormat for all numbers maintained in list
25.JUL.2000RGRFunctionality for countries without area code
25.JUL.2000RGRConstant names changes
08.JUN.2000RGRDelete method changed



Property Summary
Public Property Set AddrDataID As String
Public Property Get AddrDataID As String
Public Property Get AddrDataInstance As Variant
Public Property Get Count As Integer
Public Property Get CountriesWithoutAreaCode As Variant
Public Property Set CountriesWithoutAreaCode As Variant
Public Property Get DefaultPhoneNumber As String
Public Property Set ItemDelimiter As String
Public Property Get ItemDelimiter As String
Public Property Set ListDelimiter As String
Public Property Get ListDelimiter As String
Public Property Set NotAllowedChars As Variant
Public Property Get NotAllowedChars As Variant
Public Property Get PhoneFormat As Variant
Public Property Set PhoneFormat As Variant
Public Property Get PhoneNumberDefaultS As Variant
Public Property Get PhoneNumberKeyS As Variant
Public Property Get PhoneNumberList As Variant
Public Property Get PhoneNumberS As Variant

Method Summary
Sub AddItem (NewItem As LSAPhoneItem)
Sub ClearAllItems ()
Sub ClearCurrentItem ()
Sub Delete ()
Sub Explode (SerialDataArr As Variant)
Function GetCurrentItem () As LSAPhoneItem
Function GetDefaultItem () As LSAPhoneItem
Function GetFirstItem () As LSAPhoneItem
Function GetItemByKey (ItemKey As String, MoveCurrentItem As Integer) As LSAPhoneItem
Function GetNextItem () As LSAPhoneItem
Function getPhoneData () As String
Function GetPreviousItem () As LSAPhoneItem
Function hasChanged () As Integer
Function IsDefault (CompareItem As LSAPhoneItem) As Integer
Sub New ()
Function saveToPredefinedFields (doc As NotesDocument) As Integer
Sub SetCurrentItem (NewCurrentItem As LSAPhoneItem)
Sub SetDefaultItem (NewDefaultItem As LSAPhoneItem)
Sub UpdateCurrentItem (UpdateItem As LSAPhoneItem)

Property Detail

Public Property Set AddrDataID AsString

Sets the Instance ID of the LSAAddressData object. If this ID isn't available then the properties PhoneFormat and CountriesWithoutAreaCode have to use their default values. The ID is set by the object LSAAddressData when this object is accessed via the Property "PhoneNumbers" of the class LSAAddressData.

Summmary Top

Public Property Get AddrDataID AsString

Summmary Top

Public Property Get AddrDataInstance AsVariant

If the property AddressDataID is set to an correct Instance ID of the LSAAddressData object which can be obtained by the instance manager class this property returns a handle to object.

History:
10.AUG.2000RGRID = "" didn't work correctly
Summmary Top

Public Property Get PhoneFormat AsVariant

Summmary Top

Public Property Set PhoneFormat AsVariant


History:
11.AUG.2000RGRMissing exit property
Summmary Top

Public Property Get CountriesWithoutAreaCode AsVariant

Summmary Top

Public Property Set CountriesWithoutAreaCode AsVariant


History:
11.AUG.2000RGRMissing exit property
Summmary Top

Public Property Get DefaultPhoneNumber AsString

Returns the formatted attribute of the default phone item of the named list. If the list is empty an empty string is returned.

History:
27.JUL.2000RGRIf no default item exists an empty string is returned.
Summmary Top

Public Property Get PhoneNumberList AsVariant

Returns an array of serial data strings. Each entry corresponds to a phone number in the NamedList and can be used to explode the list.

Summmary Top

Public Property Get PhoneNumberKeyS AsVariant

Returns an array of string with the keys of the phone numbers maintained in the web page list

Summmary Top

Public Property Get PhoneNumberS AsVariant

Returns an array of string filled with the the formatted attribute of the PhoneNumberItems maintained in the web page list

Summmary Top

Public Property Get PhoneNumberDefaultS AsVariant

Returns an array of strings. On the position of the DefaultItem of the list the value is "x"

History:
23.NOV.2000RGRCurrentItemKey Pointer not moved correctly
Summmary Top

Public Property Get Count AsInteger

Returns the number of elements in the web page list

Summmary Top

Public Property Set ListDelimiter AsString

When the object is imploded to a serial data string this character will be used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get ListDelimiter AsString

Summmary Top

Public Property Set ItemDelimiter AsString

When the an item is imploded to a serial data string this character will be used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get ItemDelimiter AsString

Summmary Top

Public Property Set NotAllowedChars AsVariant

These characters are not allowed to be use in the items

Summmary Top

Public Property Get NotAllowedChars AsVariant

Summmary Top
Method Detail

New

Public Sub New
Initialzes the internal NamedLists.

Summmary Top

Delete

Public Sub Delete
Default destructor of the class. Deletes all child objects.

History:
25.JUL.2000RGRDelete handle to parent
08.JUN.2000RGRChild objects are deleted.
Summmary Top

AddItem

Public Sub AddItem(NewItem As LSAPhoneItem)
Adds a new LSAPhoneItem to the list

Parameters:
newItemLSAPhoneItemthe item which is inserted in the list
Summmary Top

ClearCurrentItem

Public Sub ClearCurrentItem
Deletes the current item from the list

Summmary Top

ClearAllItems

Public Sub ClearAllItems
Reinitializes the phone list

Summmary Top

UpdateCurrentItem

Public Sub UpdateCurrentItem(UpdateItem As LSAPhoneItem)
Updates the current item with the data from the UpdateItem

Parameters:
updateItemLSAPhoneItemitem storing the update information
Summmary Top

IsDefault

Public Function IsDefault(CompareItem As LSAPhoneItem) As Integer
Checks if the parameter item is the default item of the list.

Parameters:
CompareItemLSAPhoneItemthe item which is checked if it is the default item
Returns:
Booleantrue, if the item is the default item
Summmary Top

SetCurrentItem

Public Sub SetCurrentItem(NewCurrentItem As LSAPhoneItem)
Set the current item to the parameter item

Summmary Top

SetDefaultItem

Public Sub SetDefaultItem(NewDefaultItem As LSAPhoneItem)
Set the default item to the parameter item

Summmary Top

GetItemByKey

Public Function GetItemByKey(ItemKey As String,MoveCurrentItem As Integer) As LSAPhoneItem
Summmary Top

GetDefaultItem

Public Function GetDefaultItem As LSAPhoneItem
Returns the default item of the list or nothing.

Returns:
LSAPhoneItemthe default item
Summmary Top

GetCurrentItem

Public Function GetCurrentItem As LSAPhoneItem
Returns the current item of the list

Returns:
LSAPhoneItemitem which the current pointer is pointing at
Summmary Top

GetFirstItem

Public Function GetFirstItem As LSAPhoneItem
Returns the first item of the list

Returns:
LSAPhoneItemthe first item in the list
Summmary Top

GetNextItem

Public Function GetNextItem As LSAPhoneItem
Returns the item next to the current item of the list.

Returns:
LSAPhoneItemnext item to the current item
Summmary Top

GetPreviousItem

Public Function GetPreviousItem As LSAPhoneItem
Summmary Top

saveToPredefinedFields

Public Function saveToPredefinedFields(doc As NotesDocument) As Integer
Stores attribute values for the convinience of the programmer. The fields of documents relate to the subform LSASubPhone from LSL-Address The attribute are only stored if they differ from the values on disk.

Parameters:
docNotesDocumentthe document in which the attributes are stored
Returns:
Booleantrue, if an document item has been changed
Summmary Top

Explode

Public Sub Explode(SerialDataArr As Variant)
Fills the list with the serialized object provided by the parameter array The array should be of th form ' [~~x~Office~49~123~12345~12~+49-(0)123-123 45-12, ' ~~~Mobile~49~172~12345~~+49-(0)172-123 45] The list also reinitialized this means hasChanged delivers false.

Parameters:
SerialdataArrVariantarray of serial data strings each entry representing an item
Summmary Top

hasChanged

Public Function hasChanged As Integer
Checks if the list has been modified since creation or the last call of the explode method.

Summmary Top

getPhoneData

Public Function getPhoneData As String
Interface for the class LSAAddressData. Calculates a string of the type ##LotusP# as used in the default data string of an unit

Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:45:33 AM